Spring starter declarative config #14062

zeitlinger · 2025-06-18T16:13:15Z

otelbot-java-instrumentation · 2025-06-18T16:19:13Z

🔧 The result from spotlessApply was committed to the PR branch.

zeitlinger · 2025-06-19T17:48:25Z

@laurit can you help me figure out what the problem is?

AgentInstrumentationTest > classPathSetUp() FAILED	
    java.lang.NoClassDefFoundError: io/opentelemetry/sdk/autoconfigure/spi/ConfigProperties	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:348)	
        at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:328)	
        at java.lang.ClassLoader.loadClass(ClassLoader.java:351)	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:264)	
        at instrumentation.AgentInstrumentationTest.classPathSetUp(AgentInstrumentationTest.java:53)

zeitlinger · 2025-06-20T06:20:26Z

@laurit can you help me figure out what the problem is?

AgentInstrumentationTest > classPathSetUp() FAILED	
    java.lang.NoClassDefFoundError: io/opentelemetry/sdk/autoconfigure/spi/ConfigProperties	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:348)	
        at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:328)	
        at java.lang.ClassLoader.loadClass(ClassLoader.java:351)	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:264)	
        at instrumentation.AgentInstrumentationTest.classPathSetUp(AgentInstrumentationTest.java:53)

tried to fix that with cbb070b

laurit · 2025-06-20T12:35:14Z

@laurit can you help me figure out what the problem is?

AgentInstrumentationTest > classPathSetUp() FAILED	
    java.lang.NoClassDefFoundError: io/opentelemetry/sdk/autoconfigure/spi/ConfigProperties	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:348)	
        at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:328)	
        at java.lang.ClassLoader.loadClass(ClassLoader.java:351)	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:264)	
        at instrumentation.AgentInstrumentationTest.classPathSetUp(AgentInstrumentationTest.java:53)

tried to fix that with cbb070b

DeclarativeConfigPropertiesBridge is in boot loader but it depends on io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader

zeitlinger · 2025-06-20T13:05:38Z

DeclarativeConfigPropertiesBridge is in boot loader but it depends on io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader

I can't figure out what change could have caused that.

Is the solution to not used ConfigProperties in the agent config?

zeitlinger · 2025-06-20T13:11:53Z

DeclarativeConfigPropertiesBridge is in boot loader but it depends on io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader

I can't figure out what change could have caused that.

Is the solution to not used ConfigProperties in the agent config?

Let's see if it's 7116de1

laurit · 2025-06-20T13:26:50Z

Let's see if it's 7116de1

I don't think this is going to help. javaagent-extension-api belongs to boot loader, any class you are going to use there also needs to be in boot loader. Since based on that DeclarativeConfigPropertiesBridge needs to be in boot loader, it implements io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader, and shouldn't be there. Based on that I'd say the design is broken and needs to be rethought.

zeitlinger · 2025-06-20T13:31:11Z

Let's see if it's 7116de1

I don't think this is going to help. javaagent-extension-api belongs to boot loader, any class you are going to use there also needs to be in boot loader. Since based on that DeclarativeConfigPropertiesBridge needs to be in boot loader, it implements io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader, and shouldn't be there. Based on that I'd say the design is broken and needs to be rethought.

Why is it not failing on main? DeclarativeConfigPropertiesBridge is not changed (unless I miss something)

laurit · 2025-06-20T13:50:47Z

Why is it not failing on main? DeclarativeConfigPropertiesBridge is not changed (unless I miss something)

Because on main you don't have it in boot loader. Actually I was wrong about javaagent-extension-api belonging to boot loader. During agent packaging some of it is moved to boot loader and other parts are moved to agent loader. See

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 63 in 3d8ed9f

bootstrapLibs(project(":javaagent-extension-api")) {

and

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 147 in 3d8ed9f

    
           // exclude the agent part of the javaagent-extension-api; these classes will be added in relocate tasks

and

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 432 in 3d8ed9f

// exclude the bootstrap part of the javaagent-extension-api

I'd try excluding the bridge in

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 69 in 3d8ed9f

exclude("io.opentelemetry", "opentelemetry-sdk-extension-autoconfigure-spi")

zeitlinger · 2025-06-20T15:50:32Z

I'd try excluding the bridge in

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 69 in 3d8ed9f

exclude("io.opentelemetry", "opentelemetry-sdk-extension-autoconfigure-spi")

That worked - thanks a lot!

otelbot-java-instrumentation · 2025-06-30T09:36:21Z

🔧 The result from spotlessApply was committed to the PR branch.

...lemetry/instrumentation/spring/autoconfigure/internal/resources/DistroComponentProvider.java

...io/opentelemetry/instrumentation/spring/autoconfigure/SpringDeclarativeConfigProperties.java

...lemetry/instrumentation/spring/autoconfigure/internal/resources/DistroComponentProvider.java

laurit · 2025-11-10T13:42:36Z

...io/opentelemetry/instrumentation/spring/autoconfigure/SpringDeclarativeConfigProperties.java

+    return false;
+  }
+
+  private static boolean isPrimitive(Object object) {


since String is not primitive the name is slightly misleading. Perhaps something like isSimple would be a better fit.
Also it does not list all the primitive types.

this is a copy of https://github.com/open-telemetry/opentelemetry-java/blob/89c797377767d7c58e3539158e865bed3b7abb24/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlDeclarativeConfigProperties.java#L126 - so I'd like to keep it as close as possible

...io/opentelemetry/instrumentation/spring/autoconfigure/SpringDeclarativeConfigProperties.java

.../src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/EmbeddedConfigFile.java

laurit · 2025-11-10T14:06:29Z

.../src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/EmbeddedConfigFile.java

+  static ObjectMapper getObjectMapper() {
+    try {
+      Field field = DeclarativeConfiguration.class.getDeclaredField("MAPPER");
+      field.setAccessible(true);
+      return (ObjectMapper) field.get(null);
+    } catch (NoSuchFieldException | IllegalAccessException e) {
+      throw new DeclarativeConfigException("Failed to access ObjectMapper", e);
+    }
+  }


Is the reflection worth it? Any reason you wish to avoid creating the ObjectMapper instance yourself? Since the MAPPER is package private could also consider adding a class in the same package for reading that field.

any reason

I want to make sure the config options don't diverge

static final ObjectMapper MAPPER; static { MAPPER = new ObjectMapper() // Create empty object instances for keys which are present but have null values .setDefaultSetterInfo(JsonSetter.Value.forValueNulls(Nulls.AS_EMPTY)); // Boxed primitives which are present but have null values should be set to null, rather than // empty instances MAPPER.configOverride(String.class).setSetterInfo(JsonSetter.Value.forValueNulls(Nulls.SET)); MAPPER.configOverride(Integer.class).setSetterInfo(JsonSetter.Value.forValueNulls(Nulls.SET)); MAPPER.configOverride(Double.class).setSetterInfo(JsonSetter.Value.forValueNulls(Nulls.SET)); MAPPER.configOverride(Boolean.class).setSetterInfo(JsonSetter.Value.forValueNulls(Nulls.SET)); }

.. package protected

good idea - changed

.../src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/EmbeddedConfigFile.java

laurit · 2025-11-10T14:15:34Z

.../src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/EmbeddedConfigFile.java

+          // Ensure the list is large enough
+          while (list.size() <= index) {
+            list.add(null);
+          }


ArrayList has ensureCapacity method that might simplify this

no, this doesn't work, as ensureCapacity doesn't set the size

.../src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/EmbeddedConfigFile.java

zeitlinger · 2025-11-11T09:00:43Z

@laurit thanks for the review! please check again 😄

zeitlinger self-assigned this Jun 18, 2025

github-actions bot added the test native This label can be applied to PRs to trigger them to run native tests label Jun 18, 2025

zeitlinger marked this pull request as ready for review June 19, 2025 16:09

zeitlinger requested a review from a team as a code owner June 19, 2025 16:09

zeitlinger force-pushed the spring-starter-declarative-config branch 2 times, most recently from 17d949a to f81444f Compare June 19, 2025 16:57

zeitlinger added this to Declarative Configuration: Java Jun 20, 2025

zeitlinger removed this from Declarative Configuration: Java Jun 20, 2025

zeitlinger mentioned this pull request Jun 20, 2025

Vendor specific instrumentation config options handling #14016

Merged

zeitlinger mentioned this pull request Jun 20, 2025

Internal telemetry always uses GlobalOpenTelemetry when declarative config is used open-telemetry/opentelemetry-java#7435

Closed

zeitlinger marked this pull request as draft June 25, 2025 07:07

zeitlinger force-pushed the spring-starter-declarative-config branch from bf6b7f8 to 9427fe6 Compare June 30, 2025 09:31

zeitlinger marked this pull request as ready for review June 30, 2025 10:42

zeitlinger marked this pull request as draft June 30, 2025 10:48

zeitlinger added this to Declarative Configuration: Java Jun 30, 2025

zeitlinger moved this to Blocked in Declarative Configuration: Java Jun 30, 2025

zeitlinger moved this from Blocked to In Progress in Declarative Configuration: Java Jul 4, 2025

zeitlinger removed this from Declarative Configuration: Java Jul 4, 2025

zeitlinger force-pushed the spring-starter-declarative-config branch from 482c0be to 5fcca3f Compare July 7, 2025 12:56

zeitlinger added 9 commits November 8, 2025 11:56

support multiple yaml files (for profiles)

2dd89c8

support multiple yaml files (for profiles)

02aadd0

spring config provider

520aa35

coerce types

6d031e8

coerce types

08be383

rename

9b9f4dd

cleanup

9e251b8

fix rebase

b7cbaa6

cleanup

d803eb5

zeitlinger force-pushed the spring-starter-declarative-config branch from a011497 to d803eb5 Compare November 8, 2025 11:02